home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / COMM / INTERNET / NEWS / FREENEWS / !FreeNews / !Help < prev    next >
Text File  |  1997-04-23  |  16KB  |  362 lines
  1. Installation guidelines for FreeNews
  2. ====================================
  3.  
  4. (file last updated Thu 24th April 1997 to cope with FreeNews 1.14).
  5.  
  6. NOTE
  7. ----
  8. FreeNews version 1.14 is a RELEASE version of the Freenet NNTP news fetcher.
  9. It replaces 1.13 as the release version, and all older versions are withdrawn.
  10.  
  11. However, no NNTP news system can ever be perfect, as news is propagated from 
  12. machine to machine across the internet. If you want any guarantees that all of
  13. the relevant news is downloaded, then sorry, but none will be forthcoming.
  14.  
  15. I have (and many alpha and beta testers have too) tested FreeNews quite 
  16. considerably over the last few months, and although far from being complete
  17. (I'm already working on version 1.20, with version 2.00 in the planning stage),
  18. it is certainly as usable as KA9Q, and from release 1.03 is the same speed 
  19. or faster than any news fetcher on the Acorn platform (see below).
  20.  
  21.  
  22. Features of this release
  23. ------------------------
  24.  
  25.       *  FreeNews can be configured to fetch the current DATE from the
  26.          server, rather than using the system clock.
  27.          This means that news fetching should now be more reliable, and 
  28.          removes the need for a "fudge factor" parameter, as the news
  29.          fetcher will always be in sync with the server.
  30.          
  31.       *  Optionally, if the previous feature is enabled, FreeNews can set the
  32.          local system clock based on the GMT time returned by the server. I've
  33.          not tested this outside the UK, but it works with GMT and BST times,
  34.          so I don't anticipate any problems...
  35.          
  36.          NOTE that this feature will correct the UTC (GMT) clock on your machine.
  37.          It means that you should follow Acorn guidelines here, viz:
  38.            o  The System time should always be set in GMT,
  39.            o  The *Configure TimeZone should define your current time zone
  40.               offset from GMT (or be set by a Territory module)
  41.            o  If you're in Daylight Savings Time, this should be set by
  42.               *Configure DST, *Configure BST (or territory equivalent), or by
  43.               selecting the flag on !Alarm's "Set time" window.
  44.           
  45.           In particular, note that FreeNews will not move you into Summer Time
  46.           if you've not done this, as it cannot tell if it should! (The response
  47.           from the server is always in GMT, whatever season it is called in!)
  48.  
  49. (And, in 1.13):
  50.  
  51.       *  Download headers-only.
  52.            If a group is defined to be "headers-only" (a status of 2 in
  53.            !FreeNews.Data.AllGroups) then only the new message headers will
  54.            be downloaded in that group. If you're using Messenger you'll
  55.            be able to "Fetch Body", and FreeNews will fetch the whole article
  56.            next time it connects.
  57.      
  58.       *  Auto-Configuration.
  59.            FreeNews is no longer shipped with a Config file. This means that
  60.            any preferences you setup are not overridden when new versions are
  61.            released. If the file does not exist, FreeNews will create one
  62.            using sensible values for all parameters.
  63.            
  64.       *  "No Stack for Trap handler".
  65.            These messages should no longer occur.
  66.  
  67.       *  "412 Not in a Newsgroup".
  68.            These messages should no longer occur.
  69.       
  70.       *  Auto-registration.
  71.            The first time you use a version of FreeNews > 1.13, you will be
  72.            prompted for your name and email address. This information will 
  73.            automatically be emailed to me to put you on the FreeNews mailing list.
  74.      You can stop this occurring by clicking "Cancel" when then dialog box
  75.      appears.
  76.  
  77.  
  78. Known Bugs
  79. ----------
  80.  
  81. * Date/Time not being updated. Currently, this doesn't occur if you're 
  82.   posting new news to the server. Connect again when you're not posting, and
  83.   this will work.
  84.  
  85. * "Try another server". This is not a bug in FreeNews per se; rather a problem
  86.   with the interaction with FreeNews and Acornet. The problem does not occur
  87.   when using a manually-configured freenet stack, or the Acorn stack, for
  88.   example with ANT's InetSuite.
  89.   
  90.   The problem appears the *second* time that FreeNews is used in a session.
  91.   The simple way round it is to RMReInit the InetDB module.
  92.   Version 1.12 introduced a kludge fix to this in the !Run file; simply 
  93.   quitting and restarting FreeNews will allow you to try again.
  94.   
  95.   A later release of FreeNews will solve this problem (and the following) by
  96.   changing to Stewart Brodie's multitasking DNS resolver.
  97.   
  98. * "I've clicked on 'Transfer News' and FreeNews has hung"
  99.   Actually, it is working very hard! Ok, what is actually happenning is that 
  100.   FreeNews is attempting to resolve the address of the NNTP server. After 
  101.   sending the request to the nameserver, FreeNews cannot multitask until 
  102.   the response arrives. If things take too long, press ALT-Break on RISC OS 3 
  103.   (apologies to RO2 users... are there any left?) to force FreeNews to quit,
  104.   and try again later.
  105.  
  106. * Very occasionally, the lower two lines in the status window are not updated,
  107.   even though transfer is actually happenning. If anyone can get a lead on this,
  108.   please let me know.
  109.  
  110. * "nager:Sprites22". This is an Acorn bug caused by problems surrounding the
  111.   Drawfile module and the toolbox. Make sure that you have the latest versions
  112.   of both these modules in System:modules, and THAT YOU REPLACE ALL OLDER VERSIONS
  113.   that may be in various subdirectories on your machine. Most people report
  114.   that they are surprised how many copies of Drawfile they have!
  115.   
  116. * RISC OS 3.60 USERS: You have an older version of some of the toolbox modules
  117.   in ROM than FreeNews needs. If they are in use, FreeNews is unable to replace
  118.   them with the new versions. If problems (such as "nager:Sprites22") persist,
  119.   try *Unplugging the version in ROM.
  120.  
  121. * Auto-start/quit currently have problems occasionally, specifically when
  122.   there is a problem with the initial connection to the server. My advice is
  123.   not to use these options at the moment unless you absolutely need to.
  124.  
  125. * If you've selected messages to download based on their article-ids, and 
  126.   FreeNews fails to connect at the first attempt because of "400 Server busy"
  127.   the "FetchMe" file is emptied.
  128.   
  129. * Version 1.00 of FreeNews calculated the cps figure strangely, so it
  130.   understated the speed it now obtains. It (unlike KA9Q and SLIPdial) calculates
  131.   speed from the very start of the fetch until <now>. FreeNews 1.01 and above
  132.   now calculates using a much smaller timespan to average over (8 seconds).
  133.   The cps figures shown are the newer version with the old method in brackets
  134.   for reference.
  135.   NB actual speed has not changed between 1.00 and 1.01, just the method of
  136.   calculating it.
  137.   
  138. If you are unfortunate enough to come across any other bugs, or you have any
  139. comments or requests for inclusion in future versions, please email details
  140. to freenews@roundel.demon.co.uk. Thanks.
  141.  
  142.  
  143. Distribution files
  144. ------------------
  145. !FreeNews
  146.     !Boot        - Filer boot file.
  147.     !Help          - This file!
  148.     !Run        - App. startup file. You may need to edit Wimpslot.
  149.               please let me know if you do.
  150.     !RunImage    - Application executable.
  151.     !Sprites    - Wimp icons.
  152.     !Sprites22    - High resolution wimp icons.
  153.     Acknowledge    - Acknowlegements.
  154.     Advanced    - Instructions for "Advanced Configuration".
  155.     
  156.     Data        - Directory containing files needed at runtime.
  157.        AllGroups      - list of groups to fetch all new news from.
  158.        FetchMe      - List of Message IDs to fetch completely.
  159.        FetchMeT      - "Template" empty FetchMe file.
  160.        History      - List of message ids that have been fetched.
  161.        NewGroups      - FreeNews puts any New Groups found in here.
  162.        NewIDs      - Message ids of news to be fetched this run.
  163.                    (maintained by FreeNews. Do not edit).
  164.        PostIndex      - List of filenames containing messages to post.
  165.        *~          - Previous version (backup) of file *.
  166.        
  167.     History        - History of bug fixes, releases, and fixes awaiting
  168.               implementation.
  169.     Messages    - Wimp Messages
  170.     Res        - Acorn Toolbox application resource file (UK).
  171.               If anyone wants a decompiled version so that they
  172.               can translate it to another language, please let me know
  173.               as I'd be very glad to help.
  174.     
  175.  
  176. !Syslog (app)        - Stewart Brodie's system log utility. The version that 
  177.               I supply may not be the latest, but it will work with
  178.               FreeNews. You should find the latest version at
  179.               ftp://cslib.ecs.soton.ac.uk/pub/Acorn/freenet/s.n.brodie
  180.               
  181.               Any significant actions that FreeNews does get logged
  182.               in the system_log file in this directory.
  183.               
  184.               If you have problems, changing the value of the 
  185.               SyslogD_Debug parameter in the !Run file will cause
  186.               more information to be logged to the syslog.
  187.  
  188. In FreeNews_Support:
  189. --------------------
  190. (FreeNews_Support is *not* required if you have RISC OS 3.70 - the system ROM
  191. contains newer versions!)
  192.  
  193. !SysMerge (app)        - Acorn-written utility to upgrade your !System
  194.  
  195. !System (app)        - FreeNews has been written using the new Acorn C
  196.               toolbox. This directory contains the toolbox modules.
  197.               Use this, in association witgh !SysMerge to update 
  198.               your !System.
  199.  
  200.  
  201. Setting up
  202. ----------
  203. I've tried to make this as simple as possible, but one or two things need to be
  204. done before you can successfully use FreeNews.
  205.  
  206. Installation:
  207.         * Copy !FreeNews to the same directory as your other internet utilities.
  208.           Specifically, !NewsBase and !NewsDir need to be seen before FreeNews
  209.           will run.
  210.           
  211.  
  212. Newsbase:
  213.     * Enter the Newsbase Setup "Transport setup" window. Choose
  214.       "freenews" as    the "default news route".
  215.       
  216.     * Ensure that the line "Source transport" in the transport control
  217.       window is set to "freenews", even if you are using KA9Q for mail.
  218.       If this is not done, new group information will not be added to
  219.       NewsBase. YOU HAVE BEEN WARNED. Graham Allan was looking into a fix
  220.       to NewsBase for this and may well have fixed it, but I haven't 
  221.       tested it.
  222.     
  223.     * (for Newsbase 0.55 onwards, ensure that for the freenews transport,
  224.       mail checking is inactive, news checking is active.
  225.     
  226.     * Save all changes here.
  227.  
  228. FreeNews:
  229.     * ONLY DO THIS IF YOU'RE ALREADY GETTING NEWS FROM ELSEWHERE.
  230.       IF NEWSBASE DOESN'T KNOW ABOUT A GROUP, YOU SHOULD ADD GROUPS TO
  231.       NEWSBASE, AND FREENEWS WILL AUTOMATICALLY BE UPDATED.
  232.     
  233.         Edit the file !FreeNews.Data.AllGroups. This should contain the groups
  234.       that you wish to subscribe to, one per line. The use of "*" at the
  235.       end of a name is valid for wildcard purposes.
  236.       
  237.       Note that the format of the file is <name><TAB><fetchmode>.
  238.       
  239.       If you are upgrading from KA9Q, take your existing newsfeed file
  240.       (*News, e.g. demnews), copy it to AllGroups, and edit it to add the
  241.       <TAB>1.
  242.       
  243.       <Fetchmode> is either "0" for "Don't fetch"
  244.                           "1" for "Fetch everything new in this group"
  245.                 "2" for "Fetch only the headers for new articles" 
  246.                 
  247.       If you are upgrading from a very early version of FreeNews (0.98 and
  248.       before), you must edit this file to include the <TAB>1.
  249.     
  250.     * Run !FreeNews, and open the preferences window. Note that Acorn's
  251.       interactive help is supported here.
  252.     
  253.     * Enter at least one news server name. Ensure the server you wish to use
  254.       is selected by the radio button on the left.
  255.       
  256.       The other lines are simply for your convenience in case the server
  257.       of your preference is down, it is easy to choose another server.
  258.         
  259.     * Enter a date and time for fetching or click on "catch up".
  260.         
  261.     * Accept/save these changes by clicking OK.
  262.     
  263.  
  264. Using FreeNews
  265. --------------
  266. Once setup, FreeNews is simple to operate. Choose "Transfer News" from the iconbar
  267. menu to start the process running. The text under the icon (if configured) will
  268. change to indicate progress (or lack of!) For more information, clicking select
  269. on the iconbar icon will open a status window. This status window can also be
  270. opened by selecting the relevant entry on the iconbar menu, or automatically,
  271. according to the preferences.
  272.  
  273. FreeNews will attempt to be clever if you drop your connection part-way through
  274. a fetch. Next time you connect, only those articles that were not downloaded in
  275. full previously will be fetched again. The exception is the "FetchMe" file.
  276. Any articles that have been requested manually will be fetched again, as the
  277. "FetchMe" file is only cleared down after a successful completion.
  278.  
  279. If FreeNews fails for any reason, it should show an error window before dying.
  280. If you find it just removes itself from the icon bar, have a look in the
  281. system_log file (held within !Syslog).
  282.  
  283. If you want to speed things up a little at the expense of debugging information,
  284. Edit the !FreeNews.!Run file and change the parameter on the SyslogD_Debug line.
  285. The lower the number (it goes to zero meaning next to no logging) the less 
  286. disk activity there will be. If you do find a fault, I'd like to see the relevant
  287. bit of the syslog at level 5 or above (pref. level 7).
  288.  
  289. The values of SyslogD_Debug: (only applies to version 1.14:)
  290.     0: Errors and start/stop are logged.
  291.     1: As 0 + Warnings are logged
  292.     2: As 1 + Commands from FreeNews to the server are logged.
  293.        and Date/time setting variables are output.
  294.     3: As 2 + all responses from the server are logged (NB: This is *S-L-O-W*)
  295.     higher levels should only be used on request, as they will generate
  296.     masses of log information.
  297.  
  298.  
  299. Compatability
  300. -------------
  301. FreeNews should be compatible with *any* standard TCP/IP stack. I've tested it
  302. with Freenet version 0.20 and the ANT Internet suite at 1.15. Other beta testers
  303. have used Acorn TCP/IP without problems. FreeNews will *not* work with KA9Q
  304. (aka !TCPTP) or Termite Internet, as these are not standard stacks.
  305.  
  306. Error messages that may be displayed whilst running with ANT stack with Fresco
  307. are a fault with the Acorn written code within the ANT stack. ANT are aware of 
  308. this.
  309.  
  310.  
  311. The Future
  312. ----------
  313. Just because FreeNews is now stable enough to be numbered above 1.00 does not
  314. mean that this is it. FreeNews is still evolving. My plan of action for the
  315. near future is as follows:
  316.  
  317. * The ability to edit the fetch status of groups.
  318.  
  319. * The facility of selecting from headers by THREAD rather than individually.
  320.  
  321. * The provision of auto-select and auto-kill functions that will automatically
  322.   download the body of articles that you've already expressed interest in, and
  323.   conversely to "kill" the headers of certain articles after download so you will
  324.   not be shown the header, and the body will not be downloaded.
  325.   
  326. * The facility to associate a cost with individual newsgroups so that high traffic
  327.   groups are only downloaded when telephone calls are cheap, and very low-traffic
  328.   or important groups are fetched regardless of the time.
  329.  
  330.  
  331. Any Questions?
  332. --------------
  333. Or observations/requests? Why not ask other users by talking to the FreeNews 
  334. mailing list: Send mail to freenews-l@roundel.demon.co.uk.
  335.  
  336. Really stumped? Then please feel free to contact me by email at
  337. freenews@roundel.demon.co.uk.
  338.  
  339.  
  340. Licence
  341. -------
  342. FreeNews is © Copyright 1995-7 John Smith and Neil Clegg and is released as
  343. freeware.
  344.  
  345. Permission is granted to use FreeNews on the understanding that this use
  346. is entirely at your own risk.  We accept no liability whatsoever for any
  347. loss or damage arising from the use of FreeNews nor do we make any guarantee
  348. that it is fit for any purpose.  You may not distribute FreeNews
  349. in any form without express permission, unless all files are present and
  350. unchanged. No charges may be made (other than reasonable postage/packing costs)
  351. for distribution.
  352.  
  353. PD Libraries and BB sysops should contact me to ensure that they have the latest
  354. version.
  355.  
  356.  
  357. Toolbox Modules
  358. ---------------
  359. FreeNews may have been distributed with Acorn's Toolbox modules.  These
  360. modules are Copyright © Acorn Computers Ltd.  You may not distribute them
  361. unless you have a licence from Acorn to do so.
  362.